Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: fix pre-commit config and adapt code to make all checks pass #162

Merged
merged 25 commits into from
Jun 26, 2024
Merged

chore: fix pre-commit config and adapt code to make all checks pass #162

merged 25 commits into from
Jun 26, 2024

Conversation

mojomex
Copy link
Collaborator

@mojomex mojomex commented Jun 7, 2024

PR Type

  • Improvement

Description

This PR is a preliminary step to

and makes pre-commit pass on the current codebase.
This involved:

  • fixing the pre-commit configuration (and that of its hooks):
    • revert prettier version from 4.0.0-alpha.8 to 3.1.0
    • disable prettier on yaml and json files (as they are handled by yamllint and clang-format respectively)
    • add clang-format config for json
    • add exception in yamllint for .clang-format as its format is required to be non-standard
  • implementing the code changes flagged by pre-commit hooks
    • whitespace changes
    • import changes
    • copyright notices in cpp/hpp source files
    • quoting changes in yaml files
    • added/removed qualifiers like explicit, override, etc.
    • ...

pre-commit is now passing.

Review Procedure

Make sure to check "hide whitespace" and click apply/reload in the "changed files" view's settings when reviewing:

Pre-Review Checklist for the PR Author

PR Author should check the checkboxes below when creating the PR.

  • Assign PR to reviewer

Checklist for the PR Reviewer

Reviewers should check the checkboxes below before approval.

  • Commits are properly organized and messages are according to the guideline
  • (Optional) Unit tests have been written for new behavior
  • PR title describes the changes

Post-Review Checklist for the PR Author

PR Author should check the checkboxes below before merging.

  • All open points are addressed and tracked via issues or tickets

CI Checks

  • Build and test for PR: Required to pass before the merge.

@mojomex mojomex self-assigned this Jun 7, 2024
@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 5.17241% with 55 lines in your changes missing coverage. Please review.

Please upload report for BASE (develop@46171bf). Learn more about missing BASE report.

Files Patch % Lines
nebula_ros/src/robosense/decoder_wrapper.cpp 0.00% 32 Missing ⚠️
...src/nebula_decoders_robosense/robosense_driver.cpp 0.00% 4 Missing ⚠️
nebula_ros/src/hesai/hesai_ros_wrapper.cpp 0.00% 3 Missing ⚠️
...s/nebula_decoders_robosense/decoders/bpearl_v3.hpp 0.00% 2 Missing ⚠️
...s/nebula_decoders_robosense/decoders/bpearl_v4.hpp 0.00% 2 Missing ⚠️
...ders/nebula_decoders_robosense/decoders/helios.hpp 0.00% 2 Missing ⚠️
...a_decoders_robosense/decoders/robosense_packet.hpp 0.00% 2 Missing ⚠️
nebula_ros/src/robosense/robosense_ros_wrapper.cpp 0.00% 2 Missing ⚠️
nebula_ros/src/velodyne/velodyne_ros_wrapper.cpp 0.00% 2 Missing ⚠️
nebula_common/src/nebula_common.cpp 0.00% 1 Missing ⚠️
... and 3 more

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files 
@@            Coverage Diff             @@
##             develop     #162   +/-   ##
==========================================
  Coverage           ?   14.13%           
==========================================
  Files              ?       82           
  Lines              ?     7585           
  Branches           ?     1179           
==========================================
  Hits               ?     1072           
  Misses             ?     5679           
  Partials           ?      834
Flag Coverage Δ
differential 14.13% <5.17%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mojomex added 22 commits June 7, 2024 19:37
@mojomex
chore: fix pre-commit versions and clang-format hook failure
8a09f5e
@mojomex
chore(docs): fix documentation pre-commit errors
c442c8c
@mojomex
chore: fix pre-commit and compiler warnings in all code files modifie…
084f172 
…d between main..develop
@mojomex
chore(yamllint): ignore yaml document start in clang-format config as…
2973053 
… it is required
@mojomex
chore: add copyright and license headers
2bdae1d
@mojomex
chore(pre-commit): allow multiple documents in YAML files to make .cl…
83e9a85 
…ang-format file check pass
@mojomex
chore: make pre-commit pass for parameter schema code
cfe3d0c
@mojomex
chore: add copyright and license to all source files
66783f5
@mojomex
chore: implement pre-commit suggestions in all CPP/HPP files
f080524
@mojomex
chore: whitespace changes in non-cpp files to satisfy pre-commit
d633414
@mojomex
chore: flake8 changes to satisfy pre-commit
7adf53e
@mojomex
fix: allow implicit conversion to status types again
fa95f61
@mojomex
chore: clean up imports
9cfe040
@mojomex
chore: add override/inline where necessary
6748ca9
@mojomex
chore(nebula_ros): remove obsolete wrapper base types
3f0f35a
@mojomex
chore: move nolint comments to be robust to formatting linebreaks
3032f0b
@mojomex
chore(velodyne): fix indentation in velodyne calibration files to sat…
ff3a6a6 
…isfy yamllint and ignore them in prettier to prevent conflicting styles
@mojomex
chore(hesai): fix decoder test config yaml quotations
b4aa564
@mojomex
chore: whitespace changes
1bc62e3
@mojomex
chore: remove empty, un-parseable local.cspell.json
592f88d
@mojomex
chore(prettier): ignore yaml and json files as they are handled by ya…
950dce5 
…mllint/clang-tidy respectively
@mojomex
chore: make pre-commit pass on new files after tier4#146
f79f42f
@mojomex mojomex force-pushed the pre-commit-fixes branch 2 times, most recently from 205e156 to c2d15eb Compare June 7, 2024 11:00
@mojomex mojomex requested a review from drwnz June 7, 2024 17:04
@mojomex mojomex mentioned this pull request Jun 17, 2024
Open
drwnz
drwnz approved these changes Jun 26, 2024
View reviewed changes
Copy link
Collaborator

@drwnz drwnz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mojomex mojomex merged commit 10725e4 into tier4:develop Jun 26, 2024
8 of 9 checks passed
@mojomex mojomex deleted the pre-commit-fixes branch June 26, 2024 10:19
@mojomex mojomex mentioned this pull request Jul 18, 2024
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@drwnz drwnz drwnz approved these changes

Assignees

@mojomex mojomex

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mojomex @codecov-commenter @drwnz